More fleshing-out of documentation
authorparkrrrr <parkrrrr>
Thu, 1 Jun 2006 02:22:37 +0000 (02:22 +0000)
committerparkrrrr <parkrrrr>
Thu, 1 Jun 2006 02:22:37 +0000 (02:22 +0000)
16 files changed:
xmldoc/formats/geo.xml
xmldoc/formats/google.xml
xmldoc/formats/nmea.xml
xmldoc/formats/options/geo-deficon.xml
xmldoc/formats/options/geo-nuke_placer.xml
xmldoc/formats/options/geoniche-category.xml
xmldoc/formats/options/nmea-date.xml
xmldoc/formats/options/nmea-gpgga.xml
xmldoc/formats/options/nmea-gpgsa.xml
xmldoc/formats/options/nmea-gprmc.xml
xmldoc/formats/options/nmea-gpvtg.xml
xmldoc/formats/options/nmea-pause.xml
xmldoc/formats/options/nmea-snlen.xml
xmldoc/formats/options/nmn4-index.xml
xmldoc/formats/options/yahoo-addrsep.xml
xmldoc/formats/yahoo.xml

index 22bbd07f51b0c2c2167d81641d05de10af35f6de..7cd659e09d84eaad0d804f913da0eb17c417be75 100644 (file)
@@ -1,7 +1,11 @@
-
-      
-      
-      <para>geocaching.com spits up geocaching.loc files that are
-XML-ish but not quite GPX.  Becuase it's so close to GPX, this format
-is very well supported.</para>
-    
+<para>
+This format supports the Geocaching.com/EasyGPS ".loc" format.  This format
+was created specifically for Geocaching.com and is not the same as the 
+standard EasyGPS .loc format.  See the <link linkend="fmt_easygps">EasyGPS</link> 
+or <link linkend="fmt_gpx">GPX</link> formats for more general EasyGPS support.
+</para>
+<para>
+This is a simple XML-based format containing only very basic information 
+about geocaches.  If you can use the <link linkend="fmt_gpx">GPX</link> 
+format instead, you should consider doing so as it is a much richer format.
+</para>
index 33326563f8e9a0a9cbc2c0f45c3007af8a145892..f564951aeb5f4ccfd4fa589b48e40b93c7016b0e 100644 (file)
@@ -5,10 +5,27 @@
 tack "&amp;output=js" onto the end of a Google Maps route URL (use
 the "link to this page" option to get a usable URL.)  This allows you
 to plan a route using Google Maps, then download it and use it in your
-own mapping program or GPS receiver.  If you use a Unix-compatible
+own mapping program or GPS receiver.   To get a file suitable for use
+with GPSBabel, plan your route as usual with Google Maps.  Once you've 
+got it the way you want it, click the "Link to this page" link in the
+upper right-hand corner of the Google Maps page.  Then, edit the URL 
+that appears in your address bar by adding "&amp;output=js" (without
+the quotes) onto the end.  Hit enter, and the resulting page will be
+mostly empty.  It doesn't look like much, but it contains exactly what 
+GPSBabel needs.  Save it to disk using whatever menu option your web 
+browser provides.
+</para>
+<para>
+Note that if you are using Microsoft Internet Explorer, you should make sure
+to save the web page as "Web Page, HTML Only".  If you save it as "Web Page,
+Complete", it will be reformatted into a non-XHTML format that GPSBabel 
+cannot read.
+</para>
+<para>
+If you use a Unix-compatible
 operating system, this shell script might be useful:
 </para>
-      <programlisting format="linespecific">
+<programlisting format="linespecific">
 #!/bin/sh 
 FROM="233 S. Upper Wacker Dr, Chicago, IL" 
 TO="1060 W. Addison St, Chicago, IL" 
@@ -16,8 +33,4 @@ wget -O - "http://maps.google.com/maps?q=$FROM to $TO&amp;output=js" \
 2&amp;&gt;/dev/null &gt;google_map.js
 gpsbabel -i google -f google_map.js -o gpx -F google_map.gpx
 </programlisting>
-      <para> Note that Internet Explorer has been observed to damage
-the XHTML beyond recognition so use a better browser to save the pages
-such as Firefox or Mozilla.
-</para>
     
index a9589f7891f1576b50d5de45d876984f266b79a1..955f55e4c0b1b5480824acc9f024fc5e28211321 100644 (file)
@@ -1,33 +1,36 @@
-
-      
-      
-      <para> This format is the file representation of the NMEA0183
-log and waypoint format.  Representative programs include:</para>
-      <para>
-            <ulink url="http://www.genimap.fi/kuluttajatuotteet/alue2.asp?folder=38&amp;subfolder=16662&amp;2057">genimap.fi</ulink>
-         </para>
-      <para>
-            <ulink url="http://homepages.tig.com.au/~robk/datalogger.html">homepages.tig.com.au</ulink>
-         </para>
-      <para>
-            <ulink url="http://www.gpstm.com/eng/features_eng.htm ">gpstm.com</ulink>
-         </para>
-      <para>
-            <ulink url="http://www.gpsmaster.nl/ ">gpsmaster.nl</ulink>
-         </para>
-      <para>
-            <ulink url="http://www.silcom.com/~rwhately/index.html">silcom.com/~rwhately</ulink>
-         </para>
-      <para>
-            <ulink url="http://www.visualgps.net/VisualGPSce/default.htm">visualgps.net</ulink>
-         </para>
-      <para>
-            <ulink url="http://www.gpsu.co.uk/">gpsu.co.uk</ulink>
-         </para>
-      <para>
-            <ulink url="http://www.kolumbus.fi/eino.uikkanen/geoconvgb/index.htm">kolumbus.fi</ulink>
-         </para>
-      <para>
-            <ulink url="http://www.commlinx.com.au/GPS_recorder.htm">commlinkx.com</ulink>
-         </para>
     
+      
+<para> This format is the file representation of the NMEA 
+(National Marine Electronics Association) 0183
+log and waypoint format for GPS devices.  Some hardware and software
+that work with NMEA-0183 formatted data include:
+</para>
+<simplelist columns="3">
+<member>
+  <ulink url="http://homepages.tig.com.au/~robk/datalogger.html">GPS Data Logger</ulink>
+</member>
+<member>
+  <ulink url="http://www.gpstm.com/eng/features_eng.htm ">GPS TrackMaker</ulink>
+</member>
+<member>
+  <ulink url="http://www.gpsmaster.nl/ ">GPSMaster</ulink>
+</member>
+<member>
+  <ulink url="http://www.silcom.com/~rwhately/index.html">NMEAlog</ulink>
+</member>
+<member>
+  <ulink url="http://www.visualgps.net/VisualGPSce/default.htm">VisualGPS</ulink>
+</member>
+<member>
+  <ulink url="http://www.gpsu.co.uk/">GPS Utility</ulink>
+</member>
+<member>
+  <ulink url="http://www.kolumbus.fi/eino.uikkanen/geoconvgb/index.htm">GeoConv</ulink>
+</member>
+<member>
+  <ulink url="http://www.commlinx.com.au/GPS_recorder.htm">CommLinx GPS recorder</ulink>
+</member>
+<member>
+  <ulink url="http://www.sparkfun.com/commerce/product_info.php?products_id=671">SparkFun GPS Datalogger</ulink>
+</member>
+</simplelist>  
index 8b137891791fe96927ad78e64b0aad7bded08bdc..96d6f27c916b251378c045701699e8a29495e52b 100644 (file)
@@ -1 +1,17 @@
+<para>
+This option specifies the icon or waypoint type to write for each waypoint on 
+output.
+</para>
+<para>
+If this option is specified, its value will be used for all waypoints, not 
+just those that do not already have descriptions.  That is, this option 
+overrides any icon description that might be in the input file.
+</para>
+<para>
+There is no list of valid values for this option.
+</para>
+<para>
+This option has no effect on input.
+</para>
+
 
index 8b137891791fe96927ad78e64b0aad7bded08bdc..50d5a92daee484352020ddec5f59fcd387dbf1d2 100644 (file)
@@ -1 +1,9 @@
+<para>
+If this option is specified, GPSBabel will not read geocache placer information
+from a .loc file on input.  That is, it will ignore any placeer names in the
+input file.
+</para>
+<para>
+This option has no effect on output.
+</para>
 
index 8b137891791fe96927ad78e64b0aad7bded08bdc..7060b96b0ffe09ca30be4a92eaa5162954d96413 100644 (file)
@@ -1 +1,6 @@
+<para>
+This option specifies the name of the category in which to place the
+waypoints.  If this option is not specified, the default category is
+"Cache".
+</para>
 
index 8b137891791fe96927ad78e64b0aad7bded08bdc..81467a8c9cdc0ed411772604556369edf829bda6 100644 (file)
@@ -1 +1,10 @@
+<para>
+On input, track points with times but no dates will have this date applied.  
+</para>
+<para>
+This is necessary because some NMEA sentences contain times but no dates.  If
+this option is not specified and the date cannot be determined from one or 
+more of the available NMEA sentences, the tracks will be discarded.
+</para>
+
 
index 8b137891791fe96927ad78e64b0aad7bded08bdc..2b89b5072a78c37f2a7be1577711665907f29838 100644 (file)
@@ -1 +1,8 @@
-
+<para>
+This option tells GPSBabel whether to read (on input) or write (on output) 
+GPGGA sentences.  The default is to read or write GPGGA sentences.  To 
+disable GPGGA sentences, specify <option>gpgga=0</option>.
+</para>
+<para>
+GPGGA sentences contain the location and quality of the GPS position fix.
+</para>
index 8b137891791fe96927ad78e64b0aad7bded08bdc..40412dd84ca2285a4cd22fe52f0a8b246a94c189 100644 (file)
@@ -1 +1,12 @@
+<para>
+This option tells GPSBabel whether to read (on input) or write (on output) 
+GPGSA sentences.  The default is to read or write GPGSA sentences.  To 
+disable GPGSA sentences, specify <option>gpgsa=0</option>.
+</para>
+<para>
+GPGSA sentences contain information on the quality of the positional fix
+and the individual satellites from which it was derived.  However, GPSBabel
+neither reads nor writes the individual satellite data.  On input, the 
+satellite fields are ignored and on output they are left blank.
+</para>
 
index 8b137891791fe96927ad78e64b0aad7bded08bdc..d6b3f2d1eabaf904ee2cb427aa0550012364bd4d 100644 (file)
@@ -1 +1,11 @@
+<para>
+This option tells GPSBabel whether to read (on input) or write (on output) 
+GPRMC sentences.  The default is to read or write GPRMC sentences.  To 
+disable GPRMC sentences, specify <option>gprmc=0</option>.
+</para>
+<para>
+GPRMC sentences contain the "recommended mimimum" positional information, 
+including date and time, heading, and velocity.  Note that they do not 
+include altitude.  For altitude, you will have to include GPGGA sentences.
+</para>
 
index 8b137891791fe96927ad78e64b0aad7bded08bdc..85d587517f77f9e36239b5dc5c6cb7801d579ffd 100644 (file)
@@ -1 +1,11 @@
+<para>
+This option tells GPSBabel whether to read (on input) or write (on output) 
+GPVTG sentences.  The default is to read or write GPVTG sentences.  To 
+disable GPVTG sentences, specify <option>gpvtg=0</option>.
+</para>
+<para>
+GPVTG sentences contain information about the heading and the speed at the
+time of the fix.  They do not contain any location information; for that 
+you will need either or both of GPGGA or GPRMC.
+</para>
 
index 8b137891791fe96927ad78e64b0aad7bded08bdc..72e42ec73d44439e9fb9ef0d111b4a2f0381deaf 100644 (file)
@@ -1 +1,31 @@
+<para>
+This option tells GPSBabel to pause between individual track records when
+used on output.  This may be used with appropriate external software or 
+hardware to simulate a GPS receiver for testing purposes.  On Unix, for
+example, you may use a named pipe to feed the output from GPSBabel to gpsd.
+</para>
+<para>
+If a value for this option is specified, it is in seconds and it may be
+either a whole number of seconds or a fraction (e.g. 0.5 for a 1/2 second
+pause between trackpoints.)
+</para>
+<para>
+If this option is specified without a value, the time between adjacent 
+trackpoints will be computed and used for the length of the pause.  That is,
+if your trackpoints are 5 seconds apart, GPSBabel will pause 5 seconds 
+between trackpoints.
+</para>
+<para>
+Note that very long tracks may be subject to clock drift, as GPSBabel does 
+not take into account the amount of time it may take to write the NMEA 
+sentences.  Also, there is no guarantee that it will pause for exactly the
+specified number of seconds between samples; different operating systems 
+will allow greater or lesser precision for timers, so actual precision may
+be as much as plus or minus 100 milliseconds.
+</para>
+<para>
+If you are using this option with compressed or simplified tracks from 
+your handheld GPS receiver, you might find the 
+<link linkend="filter_interpolate">interpolate</link> filter useful.
+</para>
 
index 8b137891791fe96927ad78e64b0aad7bded08bdc..36e9c734bd7134cd747209df47cfc04703e77385 100644 (file)
@@ -1 +1,6 @@
+<para>
+This option specifies the maximum length to be used for waypoint names in 
+the GPWPL sentence.  Longer names will be shortened to no more than this 
+length, but all waypoint names will remain unique.
+</para>
 
index 8b137891791fe96927ad78e64b0aad7bded08bdc..8b7f0c4f0a995cc32eace37795db766fa17d81f5 100644 (file)
@@ -1 +1,9 @@
+<para>
+Because the format supports only one route, this option may be used 
+on output to select a single route from a collection of 
+routes read from a more expressive format.  If you have, say, a 
+<link linkend="fmt_gpx">gpx</link> file that contains two routes, you may
+use this option to write them one at a time to individual files.
+</para>
+<screen format="linespecific">gpsbabel -i gpx -f routes.gpx -o nmn4,index=1 -F route1.rte -o nmn4,index=2 -F route2.rte</screen>
 
index 8b137891791fe96927ad78e64b0aad7bded08bdc..249ca3cb43df24346fdd69938add89b9ec3eb96e 100644 (file)
@@ -1 +1,9 @@
-
+<para>
+This option specifies the string GPSBabel should use to separate the parts
+of the street address.  Since most other formats supported by GPSBabel do 
+not support street addresses, the street address fields from the Yahoo file
+are concatenated into the waypoint "notes" field.
+</para>
+<para>
+The default value for this option is a comma followed by a space (", ").
+</para>
index c64225e3a162b8dbbe7053e46de6425eaad336f5..af379358d29edae7538f1bca5b047ba2bee66a4a 100644 (file)
@@ -4,3 +4,4 @@ This format reads output from the
 This feature of GPSBabel makes it easy to get geocoded results from 
 Yahoo into your favorite mapping program, GPS receiver, or other format.
 </para>
+